cs-webhook-xapi
📘 Documentación de la API - CS Webhook XAPI
Esta sección proporciona el significado de los atributos incluidos en la API.
🗂️ Información Base
- Título de la API: CS Webhook XAPI
- Versión: 1.0.0
- URL Base:https://cs-webhook-xapi-{env}v1.us-e1.cloudhub.io/Reemplaza
{env}con:dev(Desarrollo)qa(Aseguramiento de Calidad)prod(Producción)
🔑 CLAVES DE API
- "Authorization": "Bearer {{API_KEY}}"Atributo definido en el Header de la solicitud.
- Tipo: String
- Longitud: Mínimo 36 caracteres, máximo 37 caracteres
- Descripción: Token de autenticación requerido para acceder a la API.
- "client_id": "{{CLIENT_ID}}"Atributo definido en el Header de la solicitud.
- Tipo: String
- Longitud: Mínimo 32 caracteres, máximo 36 caracteres
- Descripción: Identificador único del cliente para autenticar la solicitud.NOTA: Estas CLAVES DE API son requeridas para realizar cualquier solicitud a nuestros servicios.
📧 Confirmación de PayU Web Checkout (POST /payu/web-checkout/confirmation)
- "transactionId"
- Tipo: String
- Longitud: Máximo 50 caracteres
- Descripción: Identificador único para la transacción de pago.
- "status"
- Tipo: String
- Valores Permitidos:
APPROVED,DECLINED,PENDING - Descripción: Estado actual de la transacción.Ejemplo de Solicitud:curl -X POST "https://cs-webhook-xapi-prod.v1.us-e1.cloudhub.io/payu/web-checkout/confirmation" -H "Content-Type: application/json" -H "client_id: TU_CLIENT_ID" -H "Authorization: Bearer TU_TOKEN_DE_ACCESO" -d '{ "transactionId": "123456", "status": "APPROVED" }'
🔍 Parámetros Comunes
| Parámetro | Tipo | Descripción | Requerido |
|---|---|---|---|
client_id | string | Identificador único para clientes de API | ✅ |
Authorization | string | Token Bearer para acceso seguro | ✅ |
transactionId | string | ID de transacción de pago | ✅ |
status | string | Estado del pago | ✅ |
🛡️ Esquemas de Seguridad
Aplicación de Client ID
| Campo | Tipo | Requerido | Longitud (caracteres) | RegEx |
|---|---|---|---|---|
client_id | String | Sí | 32 - 36 | [a-zA-Z0-9] |
client_secret | String | Sí | 32 - 64 | [a-zA-Z0-9] |
OAuth 2.0
| Campo | Tipo | Requerido | Longitud (caracteres) | RegEx |
|---|---|---|---|---|
Authorization | String | Sí | 36 - 37 | [a-zA-Z0-9-_.] |
⚠️ Códigos de Error
| Código | Descripción | Solución Sugerida |
|---|---|---|
| 400 | Solicitud Incorrecta | Verificar sintaxis y parámetros de solicitud. |
| 401 | No Autorizado | Validar credenciales de autenticación. |
| 404 | No Encontrado | Confirmar la URL del endpoint. |
| 500 | Error Interno del Servidor | Reintentar o contactar soporte técnico. |
📞 Soporte
Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.
Correo electrónico: epalma@fgs.co
📅 Información Adicional
- Documentación actualizada por última vez: Septiembre 2025
- Para actualizaciones adicionales, consulta el Portal de Exchange de API
Documentación actualizada en Septiembre 2025 por epalma@fgs.co - Edna Nayibe Palma
© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API CS Webhook XAPI